\hypertarget{classaetycoon_1_1_compressed_text_property}{
\section{aetycoon.CompressedTextProperty Class Reference}
\label{classaetycoon_1_1_compressed_text_property}\index{aetycoon::CompressedTextProperty@{aetycoon::CompressedTextProperty}}
}


Inheritance diagram for aetycoon.CompressedTextProperty:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=400pt]{classaetycoon_1_1_compressed_text_property__inherit__graph}
\end{center}
\end{figure}


Collaboration diagram for aetycoon.CompressedTextProperty:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=400pt]{classaetycoon_1_1_compressed_text_property__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
def \hyperlink{classaetycoon_1_1_compressed_text_property_a472b89db2c7893c09ad3cf5087ec53e1}{\_\-\_\-init\_\-\_\-}
\item 
def \hyperlink{classaetycoon_1_1_compressed_text_property_ab5a318647ed88ea57402413829f03af2}{value\_\-to\_\-str}
\item 
def \hyperlink{classaetycoon_1_1_compressed_text_property_a06772359df21b649360458712078ea71}{str\_\-to\_\-value}
\end{DoxyCompactItemize}
\subsection*{Static Public Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classaetycoon_1_1_compressed_text_property_aed6dea0b7f8c2b5b1294cdbfe1749048}{
{\bfseries data\_\-type} = db.Text}
\label{classaetycoon_1_1_compressed_text_property_aed6dea0b7f8c2b5b1294cdbfe1749048}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
\begin{DoxyVerb}A string that will be stored in a compressed form (encoded as UTF-8).

Example usage:

>>> class CompressedTextModel(db.Model):
...  v = CompressedTextProperty()

You can create a CompressedTextProperty and set its value with your string.
You can also retrieve the (decompressed) value by accessing the field.

>>> ustr = u'\u043f\u0440\u043e\u0440\u0438\u0446\u0430\u0442\u0435\u043b\u044c'
>>> model = CompressedTextModel(v=ustr)
>>> model.put() # doctest: +ELLIPSIS
datastore_types.Key.from_path(u'CompressedTextModel', ...)

>>> model2 = CompressedTextModel.all().get()
>>> model2.v == ustr
True

Compressed text is not indexed and therefore cannot be filtered on:

>>> CompressedTextModel.gql("WHERE v = :1", ustr).count()
0
\end{DoxyVerb}
 

\subsection{Constructor \& Destructor Documentation}
\hypertarget{classaetycoon_1_1_compressed_text_property_a472b89db2c7893c09ad3cf5087ec53e1}{
\index{aetycoon::CompressedTextProperty@{aetycoon::CompressedTextProperty}!\_\-\_\-init\_\-\_\-@{\_\-\_\-init\_\-\_\-}}
\index{\_\-\_\-init\_\-\_\-@{\_\-\_\-init\_\-\_\-}!aetycoon::CompressedTextProperty@{aetycoon::CompressedTextProperty}}
\subsubsection[{\_\-\_\-init\_\-\_\-}]{\setlength{\rightskip}{0pt plus 5cm}def aetycoon.CompressedTextProperty.\_\-\_\-init\_\-\_\- (
\begin{DoxyParamCaption}
\item[{}]{self, }
\item[{}]{level = {\ttfamily 6}, }
\item[{}]{args, }
\item[{}]{kwargs}
\end{DoxyParamCaption}
)}}
\label{classaetycoon_1_1_compressed_text_property_a472b89db2c7893c09ad3cf5087ec53e1}
\begin{DoxyVerb}Constructor.

Args:
level: Controls the level of zlib's compression (between 1 and 9).
\end{DoxyVerb}
 

Reimplemented from \hyperlink{classaetycoon_1_1_compressed_property_a86d2eb9b68c1197dec9092b4b77a9e86}{aetycoon.CompressedProperty}.



\subsection{Member Function Documentation}
\hypertarget{classaetycoon_1_1_compressed_text_property_a06772359df21b649360458712078ea71}{
\index{aetycoon::CompressedTextProperty@{aetycoon::CompressedTextProperty}!str\_\-to\_\-value@{str\_\-to\_\-value}}
\index{str\_\-to\_\-value@{str\_\-to\_\-value}!aetycoon::CompressedTextProperty@{aetycoon::CompressedTextProperty}}
\subsubsection[{str\_\-to\_\-value}]{\setlength{\rightskip}{0pt plus 5cm}def aetycoon.CompressedTextProperty.str\_\-to\_\-value (
\begin{DoxyParamCaption}
\item[{}]{s}
\end{DoxyParamCaption}
)}}
\label{classaetycoon_1_1_compressed_text_property_a06772359df21b649360458712078ea71}
\begin{DoxyVerb}Reverse of value_to_str.  By default, returns s unchanged.\end{DoxyVerb}
 

Reimplemented from \hyperlink{classaetycoon_1_1_compressed_property_affaccef3addb072512e54ea9da6c4531}{aetycoon.CompressedProperty}.

\hypertarget{classaetycoon_1_1_compressed_text_property_ab5a318647ed88ea57402413829f03af2}{
\index{aetycoon::CompressedTextProperty@{aetycoon::CompressedTextProperty}!value\_\-to\_\-str@{value\_\-to\_\-str}}
\index{value\_\-to\_\-str@{value\_\-to\_\-str}!aetycoon::CompressedTextProperty@{aetycoon::CompressedTextProperty}}
\subsubsection[{value\_\-to\_\-str}]{\setlength{\rightskip}{0pt plus 5cm}def aetycoon.CompressedTextProperty.value\_\-to\_\-str (
\begin{DoxyParamCaption}
\item[{}]{self, }
\item[{}]{model\_\-instance}
\end{DoxyParamCaption}
)}}
\label{classaetycoon_1_1_compressed_text_property_ab5a318647ed88ea57402413829f03af2}
\begin{DoxyVerb}Returns the value stored by this property encoded as a (byte) string,
or None if value is None.  This string will be stored in the datastore.
By default, returns the value unchanged.\end{DoxyVerb}
 

Reimplemented from \hyperlink{classaetycoon_1_1_compressed_property_ac1092e51ed205dd808d437d22c4a8e7e}{aetycoon.CompressedProperty}.



The documentation for this class was generated from the following file:\begin{DoxyCompactItemize}
\item 
aetycoon/\_\-\_\-init\_\-\_\-.py\end{DoxyCompactItemize}
